Remove broken link and small improvements #343
Conversation
There was a problem hiding this comment.
This is a great improvement of the JS/TS chapter, as well as a nice bonus fix to the PR template, thanks!
I leave some suggestions below for you to consider, but I don't consider them blockers for merging this PR. We can also discuss them in a separate issue first and pick them up in a next iteration.
|
|
||
| In particular, see the page about [Javascript best practices](http://www.w3.org/community/webed/wiki/JavaScript_best_practices) | ||
| Additionally, see the page about [JavaScript best practices](https://www.w3schools.com/js/js_best_practices.asp) |
There was a problem hiding this comment.
| Additionally, see the page about [JavaScript best practices](https://www.w3schools.com/js/js_best_practices.asp) | |
| Additionally, see the W3Schools page about [JavaScript best practices](https://www.w3schools.com/js/js_best_practices.asp) |
|
|
||
| # Frameworks | ||
|
|
||
| To develop a web application it is no longer enough to sprinkle some [JQuery](https://jquery.com/) calls on a html page, a JavaScript based front end web application framework must be used. The are very many frameworks, popularity is a good way to pick one. | ||
| To develop a web application it is no longer enough to sprinkle some [JQuery](https://jquery.com/) calls on a HTML page, a JavaScript based front end web application framework must be used. There are very many frameworks, popularity is a good way to pick one. | ||
| Currently the most popular frameworks are | ||
|
|
||
| * [Angular](https://angular.io/) |
There was a problem hiding this comment.
Is Angular still used (by us or others in research)?
Should we also add Svelte or other SSR frameworks?
Can also do this in a follow-up PR, but just wondering.
There was a problem hiding this comment.
I was planning to have a look at frameworks in a future branch.
|
|
||
| On Ubuntu (18.04) based systems, you can use the following commands to install NodeJS: | ||
| On Ubuntu (18.04) based systems, you can use the following commands to install Node.js: | ||
|
|
||
| ```shell | ||
| # system packages (Ubuntu/Debian) | ||
| curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash - | ||
| sudo apt-get install -y nodejs |
There was a problem hiding this comment.
Does this still work after 6 years? That would be amazing!
Could also be updated in another PR, of course.
There was a problem hiding this comment.
Didn't test this, wanted to look at this in a future branch.
| These are some good TypeScript editors: | ||
|
|
||
| * [Atom](http://atom.io) by GitHub, with the ``atom-typescript`` Atom package. | ||
| * [Brackets](http://brackets.io/?lang=en) by Adobe | ||
| * [WebStorm](https://www.jetbrains.com/webstorm/) by JetBrains | ||
| * [Visual Studio Code](https://code.visualstudio.com) by Microsoft |
There was a problem hiding this comment.
The repetition here feels a bit silly. Suggestion:
| These are some good TypeScript editors: | |
| * [Atom](http://atom.io) by GitHub, with the ``atom-typescript`` Atom package. | |
| * [Brackets](http://brackets.io/?lang=en) by Adobe | |
| * [WebStorm](https://www.jetbrains.com/webstorm/) by JetBrains | |
| * [Visual Studio Code](https://code.visualstudio.com) by Microsoft | |
| For editing TypeScript, we recommend the same editors as for JavaScript. |
There was a problem hiding this comment.
Probably best to not commit that suggestion, GitHub was warning me that there's some weirdness going on in selecting these lines in the review window.
|
|
||
| ## Debugging | ||
|
|
||
| In web development, debugging is typically done in the browser. | ||
| Typescript can not be run directly in web browser so it must be transpiled to Javascript. To map a breakpoint in the browser to a line in the original Typescript file [source maps](https://www.html5rocks.com/en/tutorials/developertools/sourcemaps/) are required. Most frameworks have a project build system which generate source maps. | ||
| TypeScript cannot be run directly in web browser so it must be transpiled to JavaScript. To map a breakpoint in the browser to a line in the original TypeScript file [source maps](https://www.html5rocks.com/en/tutorials/developertools/sourcemaps/) are required. Most frameworks have a project build system which generate source maps. |
There was a problem hiding this comment.
| TypeScript cannot be run directly in web browser so it must be transpiled to JavaScript. To map a breakpoint in the browser to a line in the original TypeScript file [source maps](https://www.html5rocks.com/en/tutorials/developertools/sourcemaps/) are required. Most frameworks have a project build system which generate source maps. | |
| TypeScript cannot be run directly in the web browser so it must be transpiled to JavaScript. To map a breakpoint in the browser to a line in the original TypeScript file [source maps](https://www.html5rocks.com/en/tutorials/developertools/sourcemaps/) are required. Most frameworks have a project build system which generate source maps. |
|
@egpbos Thanks for the review, I incorporated your suggestions in a new commit. I think this can be merged now, but I don't have the rights to do so. |
Changes in this PR
This PR intends to remove all broken links from the JS/TS page (#301) and acts as first step towards having an up to date page (#268). Some typos have been fixed and all links now have https.
The GitHub request template has been updated to use double backticks for the command to check for broken links, as the command itself uses backticks.
Closes #301
Related to #268
Checklist
SIGNIFICANT changes / additions, e.g. new chapters
ALL contributions
python3 -m http.server 4000and confirmed they work correctly.docker run --init -it -v `pwd`:/docs lycheeverse/lychee /docs --config=docs/lychee.toml, at least for the files I changed.CITATION.cfffile.EDIT: this branch should have been prefixed with
301, not310.